Allows the user to send notifications to other users through the Send Message link.
curl -X GET "https://accucampus.net/api/v1/notificationsend?token=&tousers=&togroups=&emailenabled=&onscreenenabled=&smsenabled=&title=&onscreenbody=&onscreenclick=&onscreenurl=&onscreenclass=&onscreenduration=&showonstation=&emailfromname=&emailfrom=&emailsubject=&emailbody=&textmessagebody="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
String token = token_example; // String | The authentication token.
Boolean emailenabled = true; // Boolean | Whether send the notification via email.
Boolean onscreenenabled = true; // Boolean | Whether to display the notification on screen.
Boolean smsenabled = true; // Boolean | Whether to send the notification via text message.
String title = title_example; // String | Notification title.
String tousers = tousers_example; // String | Comma-separated Ids of users to send the notification.
String togroups = togroups_example; // String | Comma-separated Ids of user groups to send the notification.
String onscreenbody = onscreenbody_example; // String | Body of the message for on-screen display.
String onscreenclick = onscreenclick_example; // String | What to do when the notification is clicked. Valid values: hide, view, url.
String onscreenurl = onscreenurl_example; // String | Url to redirect the user, if onscreenclick=url.
String onscreenclass = onscreenclass_example; // String | How to display the notification. Valid values: info, success, warning, error
Integer onscreenduration = 56; // Integer | Time in seconds to display the notification.
Integer showonstation = 56; // Integer | Whether to show the notification in the sign-in station.
String emailfromname = emailfromname_example; // String | Name of the email sender.
String emailfrom = emailfrom_example; // String | Reply-to email.
String emailsubject = emailsubject_example; // String | Subject of the email.
String emailbody = emailbody_example; // String | Body of the email.
String textmessagebody = textmessagebody_example; // String | Message for SMS. Max 160 characters.
try {
apiInstance.notificationsend(token, emailenabled, onscreenenabled, smsenabled, title, tousers, togroups, onscreenbody, onscreenclick, onscreenurl, onscreenclass, onscreenduration, showonstation, emailfromname, emailfrom, emailsubject, emailbody, textmessagebody);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#notificationsend");
e.printStackTrace();
}
}
}
import org.openapitools.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
String token = token_example; // String | The authentication token.
Boolean emailenabled = true; // Boolean | Whether send the notification via email.
Boolean onscreenenabled = true; // Boolean | Whether to display the notification on screen.
Boolean smsenabled = true; // Boolean | Whether to send the notification via text message.
String title = title_example; // String | Notification title.
String tousers = tousers_example; // String | Comma-separated Ids of users to send the notification.
String togroups = togroups_example; // String | Comma-separated Ids of user groups to send the notification.
String onscreenbody = onscreenbody_example; // String | Body of the message for on-screen display.
String onscreenclick = onscreenclick_example; // String | What to do when the notification is clicked. Valid values: hide, view, url.
String onscreenurl = onscreenurl_example; // String | Url to redirect the user, if onscreenclick=url.
String onscreenclass = onscreenclass_example; // String | How to display the notification. Valid values: info, success, warning, error
Integer onscreenduration = 56; // Integer | Time in seconds to display the notification.
Integer showonstation = 56; // Integer | Whether to show the notification in the sign-in station.
String emailfromname = emailfromname_example; // String | Name of the email sender.
String emailfrom = emailfrom_example; // String | Reply-to email.
String emailsubject = emailsubject_example; // String | Subject of the email.
String emailbody = emailbody_example; // String | Body of the email.
String textmessagebody = textmessagebody_example; // String | Message for SMS. Max 160 characters.
try {
apiInstance.notificationsend(token, emailenabled, onscreenenabled, smsenabled, title, tousers, togroups, onscreenbody, onscreenclick, onscreenurl, onscreenclass, onscreenduration, showonstation, emailfromname, emailfrom, emailsubject, emailbody, textmessagebody);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#notificationsend");
e.printStackTrace();
}
}
}
String *token = token_example; // The authentication token. (default to null)
Boolean *emailenabled = true; // Whether send the notification via email. (default to null)
Boolean *onscreenenabled = true; // Whether to display the notification on screen. (default to null)
Boolean *smsenabled = true; // Whether to send the notification via text message. (default to null)
String *title = title_example; // Notification title. (default to null)
String *tousers = tousers_example; // Comma-separated Ids of users to send the notification. (optional) (default to null)
String *togroups = togroups_example; // Comma-separated Ids of user groups to send the notification. (optional) (default to null)
String *onscreenbody = onscreenbody_example; // Body of the message for on-screen display. (optional) (default to null)
String *onscreenclick = onscreenclick_example; // What to do when the notification is clicked. Valid values: hide, view, url. (optional) (default to null)
String *onscreenurl = onscreenurl_example; // Url to redirect the user, if onscreenclick=url. (optional) (default to null)
String *onscreenclass = onscreenclass_example; // How to display the notification. Valid values: info, success, warning, error (optional) (default to null)
Integer *onscreenduration = 56; // Time in seconds to display the notification. (optional) (default to null)
Integer *showonstation = 56; // Whether to show the notification in the sign-in station. (optional) (default to null)
String *emailfromname = emailfromname_example; // Name of the email sender. (optional) (default to null)
String *emailfrom = emailfrom_example; // Reply-to email. (optional) (default to null)
String *emailsubject = emailsubject_example; // Subject of the email. (optional) (default to null)
String *emailbody = emailbody_example; // Body of the email. (optional) (default to null)
String *textmessagebody = textmessagebody_example; // Message for SMS. Max 160 characters. (optional) (default to null)
DefaultApi *apiInstance = [[DefaultApi alloc] init];
// Send notifications on screen, via email or text to users
[apiInstance notificationsendWith:token
emailenabled:emailenabled
onscreenenabled:onscreenenabled
smsenabled:smsenabled
title:title
tousers:tousers
togroups:togroups
onscreenbody:onscreenbody
onscreenclick:onscreenclick
onscreenurl:onscreenurl
onscreenclass:onscreenclass
onscreenduration:onscreenduration
showonstation:showonstation
emailfromname:emailfromname
emailfrom:emailfrom
emailsubject:emailsubject
emailbody:emailbody
textmessagebody:textmessagebody
completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
}];
var AccuCampusOpenApi3Documentation = require('accu_campus_open_api_3_documentation');
var api = new AccuCampusOpenApi3Documentation.DefaultApi()
var token = token_example; // {String} The authentication token.
var emailenabled = true; // {Boolean} Whether send the notification via email.
var onscreenenabled = true; // {Boolean} Whether to display the notification on screen.
var smsenabled = true; // {Boolean} Whether to send the notification via text message.
var title = title_example; // {String} Notification title.
var opts = {
'tousers': tousers_example, // {String} Comma-separated Ids of users to send the notification.
'togroups': togroups_example, // {String} Comma-separated Ids of user groups to send the notification.
'onscreenbody': onscreenbody_example, // {String} Body of the message for on-screen display.
'onscreenclick': onscreenclick_example, // {String} What to do when the notification is clicked. Valid values: hide, view, url.
'onscreenurl': onscreenurl_example, // {String} Url to redirect the user, if onscreenclick=url.
'onscreenclass': onscreenclass_example, // {String} How to display the notification. Valid values: info, success, warning, error
'onscreenduration': 56, // {Integer} Time in seconds to display the notification.
'showonstation': 56, // {Integer} Whether to show the notification in the sign-in station.
'emailfromname': emailfromname_example, // {String} Name of the email sender.
'emailfrom': emailfrom_example, // {String} Reply-to email.
'emailsubject': emailsubject_example, // {String} Subject of the email.
'emailbody': emailbody_example, // {String} Body of the email.
'textmessagebody': textmessagebody_example // {String} Message for SMS. Max 160 characters.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.notificationsend(token, emailenabled, onscreenenabled, smsenabled, title, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;
namespace Example
{
public class notificationsendExample
{
public void main()
{
var apiInstance = new DefaultApi();
var token = token_example; // String | The authentication token. (default to null)
var emailenabled = true; // Boolean | Whether send the notification via email. (default to null)
var onscreenenabled = true; // Boolean | Whether to display the notification on screen. (default to null)
var smsenabled = true; // Boolean | Whether to send the notification via text message. (default to null)
var title = title_example; // String | Notification title. (default to null)
var tousers = tousers_example; // String | Comma-separated Ids of users to send the notification. (optional) (default to null)
var togroups = togroups_example; // String | Comma-separated Ids of user groups to send the notification. (optional) (default to null)
var onscreenbody = onscreenbody_example; // String | Body of the message for on-screen display. (optional) (default to null)
var onscreenclick = onscreenclick_example; // String | What to do when the notification is clicked. Valid values: hide, view, url. (optional) (default to null)
var onscreenurl = onscreenurl_example; // String | Url to redirect the user, if onscreenclick=url. (optional) (default to null)
var onscreenclass = onscreenclass_example; // String | How to display the notification. Valid values: info, success, warning, error (optional) (default to null)
var onscreenduration = 56; // Integer | Time in seconds to display the notification. (optional) (default to null)
var showonstation = 56; // Integer | Whether to show the notification in the sign-in station. (optional) (default to null)
var emailfromname = emailfromname_example; // String | Name of the email sender. (optional) (default to null)
var emailfrom = emailfrom_example; // String | Reply-to email. (optional) (default to null)
var emailsubject = emailsubject_example; // String | Subject of the email. (optional) (default to null)
var emailbody = emailbody_example; // String | Body of the email. (optional) (default to null)
var textmessagebody = textmessagebody_example; // String | Message for SMS. Max 160 characters. (optional) (default to null)
try
{
// Send notifications on screen, via email or text to users
apiInstance.notificationsend(token, emailenabled, onscreenenabled, smsenabled, title, tousers, togroups, onscreenbody, onscreenclick, onscreenurl, onscreenclass, onscreenduration, showonstation, emailfromname, emailfrom, emailsubject, emailbody, textmessagebody);
}
catch (Exception e)
{
Debug.Print("Exception when calling DefaultApi.notificationsend: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$token = token_example; // String | The authentication token.
$emailenabled = true; // Boolean | Whether send the notification via email.
$onscreenenabled = true; // Boolean | Whether to display the notification on screen.
$smsenabled = true; // Boolean | Whether to send the notification via text message.
$title = title_example; // String | Notification title.
$tousers = tousers_example; // String | Comma-separated Ids of users to send the notification.
$togroups = togroups_example; // String | Comma-separated Ids of user groups to send the notification.
$onscreenbody = onscreenbody_example; // String | Body of the message for on-screen display.
$onscreenclick = onscreenclick_example; // String | What to do when the notification is clicked. Valid values: hide, view, url.
$onscreenurl = onscreenurl_example; // String | Url to redirect the user, if onscreenclick=url.
$onscreenclass = onscreenclass_example; // String | How to display the notification. Valid values: info, success, warning, error
$onscreenduration = 56; // Integer | Time in seconds to display the notification.
$showonstation = 56; // Integer | Whether to show the notification in the sign-in station.
$emailfromname = emailfromname_example; // String | Name of the email sender.
$emailfrom = emailfrom_example; // String | Reply-to email.
$emailsubject = emailsubject_example; // String | Subject of the email.
$emailbody = emailbody_example; // String | Body of the email.
$textmessagebody = textmessagebody_example; // String | Message for SMS. Max 160 characters.
try {
$api_instance->notificationsend($token, $emailenabled, $onscreenenabled, $smsenabled, $title, $tousers, $togroups, $onscreenbody, $onscreenclick, $onscreenurl, $onscreenclass, $onscreenduration, $showonstation, $emailfromname, $emailfrom, $emailsubject, $emailbody, $textmessagebody);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->notificationsend: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $token = token_example; # String | The authentication token.
my $emailenabled = true; # Boolean | Whether send the notification via email.
my $onscreenenabled = true; # Boolean | Whether to display the notification on screen.
my $smsenabled = true; # Boolean | Whether to send the notification via text message.
my $title = title_example; # String | Notification title.
my $tousers = tousers_example; # String | Comma-separated Ids of users to send the notification.
my $togroups = togroups_example; # String | Comma-separated Ids of user groups to send the notification.
my $onscreenbody = onscreenbody_example; # String | Body of the message for on-screen display.
my $onscreenclick = onscreenclick_example; # String | What to do when the notification is clicked. Valid values: hide, view, url.
my $onscreenurl = onscreenurl_example; # String | Url to redirect the user, if onscreenclick=url.
my $onscreenclass = onscreenclass_example; # String | How to display the notification. Valid values: info, success, warning, error
my $onscreenduration = 56; # Integer | Time in seconds to display the notification.
my $showonstation = 56; # Integer | Whether to show the notification in the sign-in station.
my $emailfromname = emailfromname_example; # String | Name of the email sender.
my $emailfrom = emailfrom_example; # String | Reply-to email.
my $emailsubject = emailsubject_example; # String | Subject of the email.
my $emailbody = emailbody_example; # String | Body of the email.
my $textmessagebody = textmessagebody_example; # String | Message for SMS. Max 160 characters.
eval {
$api_instance->notificationsend(token => $token, emailenabled => $emailenabled, onscreenenabled => $onscreenenabled, smsenabled => $smsenabled, title => $title, tousers => $tousers, togroups => $togroups, onscreenbody => $onscreenbody, onscreenclick => $onscreenclick, onscreenurl => $onscreenurl, onscreenclass => $onscreenclass, onscreenduration => $onscreenduration, showonstation => $showonstation, emailfromname => $emailfromname, emailfrom => $emailfrom, emailsubject => $emailsubject, emailbody => $emailbody, textmessagebody => $textmessagebody);
};
if ($@) {
warn "Exception when calling DefaultApi->notificationsend: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = openapi_client.DefaultApi()
token = token_example # String | The authentication token. (default to null)
emailenabled = true # Boolean | Whether send the notification via email. (default to null)
onscreenenabled = true # Boolean | Whether to display the notification on screen. (default to null)
smsenabled = true # Boolean | Whether to send the notification via text message. (default to null)
title = title_example # String | Notification title. (default to null)
tousers = tousers_example # String | Comma-separated Ids of users to send the notification. (optional) (default to null)
togroups = togroups_example # String | Comma-separated Ids of user groups to send the notification. (optional) (default to null)
onscreenbody = onscreenbody_example # String | Body of the message for on-screen display. (optional) (default to null)
onscreenclick = onscreenclick_example # String | What to do when the notification is clicked. Valid values: hide, view, url. (optional) (default to null)
onscreenurl = onscreenurl_example # String | Url to redirect the user, if onscreenclick=url. (optional) (default to null)
onscreenclass = onscreenclass_example # String | How to display the notification. Valid values: info, success, warning, error (optional) (default to null)
onscreenduration = 56 # Integer | Time in seconds to display the notification. (optional) (default to null)
showonstation = 56 # Integer | Whether to show the notification in the sign-in station. (optional) (default to null)
emailfromname = emailfromname_example # String | Name of the email sender. (optional) (default to null)
emailfrom = emailfrom_example # String | Reply-to email. (optional) (default to null)
emailsubject = emailsubject_example # String | Subject of the email. (optional) (default to null)
emailbody = emailbody_example # String | Body of the email. (optional) (default to null)
textmessagebody = textmessagebody_example # String | Message for SMS. Max 160 characters. (optional) (default to null)
try:
# Send notifications on screen, via email or text to users
api_instance.notificationsend(token, emailenabled, onscreenenabled, smsenabled, title, tousers=tousers, togroups=togroups, onscreenbody=onscreenbody, onscreenclick=onscreenclick, onscreenurl=onscreenurl, onscreenclass=onscreenclass, onscreenduration=onscreenduration, showonstation=showonstation, emailfromname=emailfromname, emailfrom=emailfrom, emailsubject=emailsubject, emailbody=emailbody, textmessagebody=textmessagebody)
except ApiException as e:
print("Exception when calling DefaultApi->notificationsend: %s\n" % e)
extern crate DefaultApi;
pub fn main() {
let token = token_example; // String
let emailenabled = true; // Boolean
let onscreenenabled = true; // Boolean
let smsenabled = true; // Boolean
let title = title_example; // String
let tousers = tousers_example; // String
let togroups = togroups_example; // String
let onscreenbody = onscreenbody_example; // String
let onscreenclick = onscreenclick_example; // String
let onscreenurl = onscreenurl_example; // String
let onscreenclass = onscreenclass_example; // String
let onscreenduration = 56; // Integer
let showonstation = 56; // Integer
let emailfromname = emailfromname_example; // String
let emailfrom = emailfrom_example; // String
let emailsubject = emailsubject_example; // String
let emailbody = emailbody_example; // String
let textmessagebody = textmessagebody_example; // String
let mut context = DefaultApi::Context::default();
let result = client.notificationsend(token, emailenabled, onscreenenabled, smsenabled, title, tousers, togroups, onscreenbody, onscreenclick, onscreenurl, onscreenclass, onscreenduration, showonstation, emailfromname, emailfrom, emailsubject, emailbody, textmessagebody, &context).wait();
println!("{:?}", result);
}
attendancelogcommentlist
View all the comments on a specific attendance log
Usage and SDK Samples
Scopes
Parameters
Responses